﻿/* 
   Copyright 2011 LUCA Studios LLC & John Evans

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

namespace LUCAStudios.Silverlight.Controls.DragDrop
{
    using System.Windows;
    using Draggable;

    /// <summary>
    /// Identifies a controls as an dragdropsource
    /// </summary>
    public interface IDragDropSource : IDraggable
    {
        /// <summary>
        /// Not yet supported
        /// </summary>
        bool UsePreview { get; }
        
        /// <summary>
        /// Not yet supported
        /// </summary>
        Style PreviewStyle { get; }
        
        /// <summary>
        /// Not yet supported
        /// </summary>
        bool LeaveInPlace { get; }
        
        /// <summary>
        /// General purpose property which holds any data that should follow with the dragged control.
        /// Is provided to the IDragDropTarget on a successful drop
        /// Usually this is the set to the dragging object itself, but can be used for passing any type of data
        /// </summary>
        object DragDropData { get; }
        
        /// <summary>
        /// Called when the control is dropped on a IDragDropTarget
        /// </summary>
        /// <param name="target"></param>
        void OnDropped(IDragDropTarget target);
    }
}
